Generic Integration Status API icon

Generic Integration Status API

1.0.x
(0 reviews)

Specs - ACK Status - REST API

The REST ACK Status OUT API allows you to retrieve the different integration status of your messages previously send to DALI:

Actually supported flows:

  • Timesheets IN Status
  • Sales Orders IN Status
  • Persons IN Status

Retrieval of the acknowledgment element

GET /rest/v1/status

Security

This API is secured by client_id/client_secret. These parameters are to add in the headers of your call:

  • client_id: {client_id provided by Dali}
  • client_secret: {client_secret provided by Dali}

Parameters

  • businessEntity: Required - Name of the business entity flow you want to extract.Possible values:
    • Timesheets IN Status: timesheets-ack
    • Sales Orders IN Status : salesorderstatus
    • Persons IN : employees-ack
  • companyCode : Required - Analytic company Code to retrieve (*required to use companyCode or osmoseCode_)
  • osmoseCode : Required - Osmose Code of the company to retrieve (*required to use companyCode or osmoseCode_)
  • buCode : to only extract data on a specific Business Unit
  • conversationId : to only exctract data of a specific conversation ID you have sent
  • createSince : to only exctract data created since a specific date. (Format yyyymmdd)
  • createBefore : to only exctract data created before a specific date. (Format yyyymmdd)
  • status : to only exctract data having a specific status.
    • For Timesheets Status:
      • OK
      • KO
    • For SalesOrders Status
      • N/A
    • For Persons Status
      • 0 : tbd
      • 1 : tbd
      • 2 : tbd
  • limit : to limit the number of responses per page
  • page : to define which page of data to retrieve

Response Example - SalesOrdersStatus

{
    "header": {
        "apiName": "ack-status-exp",
        "apiVersion": "1.0.6-stage-300870",
        "correlationId": "123456-6c2b-11ef-a12b-0ecbcf719caf"
    },
    "data": [
        {
            "xConversationId": "TESTID001",
            "status": "OK",
            "correlationId": "9999999-99b4-11ef-9a0f-aa62da1a08d4",
            "companyCode": "F156",
            "analyticalUnit": null,
            "businessEntity": "salesorderstatus",
            "sourceId": "testsource_fr",
            "targetId": "target",
            "timeStamp": "2024-12-31T23:59:59",
            "detailJson": {
                //JSON OBJECT RELATED TO THE BUSINESS ENTITY
            },
            "comment": null
        },
        {
            "xConversationId": "TESTID001",
            "status": "OK",
            "correlationId": "9999999-99b4-11ef-9a0f-aa62da1a08d4",
            "companyCode": "F156",
            "analyticalUnit": null,
            "businessEntity": "salesorderstatus",
            "sourceId": "testsource_fr",
            "targetId": "target",
            "timeStamp": "2024-12-31T23:59:59",
            "detailJson": {
                //JSON OBJECT RELATED TO THE BUSINESS ENTITY
            },
            "comment": null
        }
    ],
    "error": {}
}

Reviews